home *** CD-ROM | disk | FTP | other *** search
/ Mac Power 1997 December / MACPOWER-1997-12.ISO.7z / MACPOWER-1997-12.ISO / AMUG / PROGRAMMING / Raven 1.2.sit / Raven 1.2 / Source / Foundation / OS / ZPatch.cpp < prev    next >
Text File  |  1997-06-18  |  7KB  |  251 lines
  1. /*
  2.  *  File:       ZPatch.cpp
  3.  *  Summary:       Classes to help with patching traps.
  4.  *  Written by: Jesse Jones
  5.  *
  6.  *  Copyright ｩ 1996 Jesse Jones. 
  7.  *    For conditions of distribution and use, see copyright notice in ZTypes.h  
  8.  *
  9.  *  Change History (most recent first):    
  10.  *
  11.  *         <->     1/13/96    JDJ        Created (based on MacApp's class).
  12.  */
  13.  
  14. #include <ZPatch.h>
  15.  
  16. #include <OSUtils.h>
  17. #include <Traps.h>
  18.  
  19. #include <ZDebug.h>
  20. #include <ZExceptions.h>
  21.  
  22.  
  23. // ===================================================================================
  24. //    Internal Functions
  25. // ===================================================================================
  26.  
  27. //---------------------------------------------------------------
  28. //
  29. // GetTrapType
  30. //
  31. //---------------------------------------------------------------
  32. static SignedByte GetTrapType(ushort theTrap)
  33. {
  34.     return (theTrap & 0x0800) ? ToolTrap : OSTrap;
  35. }
  36.  
  37. #pragma mark -
  38.  
  39. // ===================================================================================
  40. //    class TTrapPatch
  41. // ===================================================================================
  42.  
  43. TrapPatchPtr TTrapPatch::msPatchList = nil;                    
  44.  
  45. //---------------------------------------------------------------
  46. //
  47. // TTrapPatch::TTrapPatch
  48. //
  49. //---------------------------------------------------------------
  50. TTrapPatch::TTrapPatch()
  51. {
  52.     mTrapNum = 0;
  53.     mOldTrapAddr = nil;
  54.     mPatchRoutine = nil;
  55.     mNextPatch = nil;
  56. }
  57.  
  58.  
  59. //---------------------------------------------------------------
  60. //
  61. // TTrapPatch::PatchTrap
  62. //
  63. //---------------------------------------------------------------
  64. void TTrapPatch::PatchTrap(ushort theTrapNum, void* theRoutine)
  65. {
  66.     ASSERT(mPatchRoutine != nil);    // Should have been set by the subclass.
  67.  
  68.     mTrapNum = theTrapNum;
  69.     mNextPatch = msPatchList;
  70.     msPatchList = this;
  71.  
  72.     mOldTrapAddr = NGetTrapAddress(theTrapNum, GetTrapType(theTrapNum));
  73.  
  74.     NSetTrapAddress((UniversalProcPtr) theRoutine, theTrapNum, GetTrapType(theTrapNum));
  75. } 
  76.  
  77.  
  78. //---------------------------------------------------------------
  79. //
  80. // TTrapPatch::GetPreviousPatchPtr
  81. //
  82. // GetPreviousPatchPtr: walks the patch list backwards to return 
  83. // the patch record just prior to (*thePatchPtr) in the patch list.
  84. //
  85. //---------------------------------------------------------------
  86. TrapPatchPtr TTrapPatch::GetPreviousPatchPtr() const
  87. {
  88.     TrapPatchPtr tempPatchPtr = msPatchList;
  89.  
  90.     if (tempPatchPtr == this)
  91.         return nil;
  92.         
  93.     while (tempPatchPtr != nil && tempPatchPtr->mNextPatch != this)
  94.         tempPatchPtr = tempPatchPtr->mNextPatch;
  95.         
  96.     return tempPatchPtr;
  97. }  
  98.  
  99.  
  100. //---------------------------------------------------------------
  101. //
  102. // TTrapPatch::GetNewerPatchPtr
  103. //
  104. // GetNewerPatchPtr: returns a newer patch record in the patch list 
  105. // which has the *same* trapNum as thePatch.
  106. //
  107. //---------------------------------------------------------------
  108. TrapPatchPtr TTrapPatch::GetNewerPatchPtr() const
  109. {
  110.     TrapPatchPtr newerPatch = nil;
  111.     TrapPatchPtr tempPatchPtr = msPatchList;
  112.  
  113.     while (tempPatchPtr != nil && tempPatchPtr != this) {
  114.         if (tempPatchPtr->mTrapNum == mTrapNum)
  115.             newerPatch = tempPatchPtr;
  116.         tempPatchPtr = tempPatchPtr->mNextPatch;
  117.     }
  118.     
  119.     return newerPatch;
  120. } 
  121.  
  122.  
  123. //---------------------------------------------------------------
  124. //
  125. // TTrapPatch::UnpatchTrap
  126. //
  127. //---------------------------------------------------------------
  128. void TTrapPatch::UnpatchTrap()
  129. {
  130.     // You can't patch nothing, so we use the old trap address to keep track of if we
  131.     // have a patch installed. 
  132.     if (mOldTrapAddr == nil)
  133.         return;
  134.     
  135.     // If this trap has a newer patch than the patch we're removing, then we have to take
  136.     // some extra special precautions. We have to muck with that patch's mOldTrapAddr to
  137.     // point to this patch record's mOldTrapAddr. We can pretty well ignore the case of
  138.     // an older patch on this same trap since the trapaddress in our patch record will
  139.     // be correct.
  140.     
  141.     // only set the trap address if there *isn't* a newer patch
  142.     TrapPatchPtr newerPatchPtr = this->GetNewerPatchPtr();
  143.     if (newerPatchPtr == nil)
  144.         NSetTrapAddress(mOldTrapAddr, mTrapNum, GetTrapType(mTrapNum));
  145.     else
  146.         // set up newerPatchPtr patch record so that it points to thePatch's mOldTrapAddr 
  147.         newerPatchPtr->mOldTrapAddr = mOldTrapAddr;
  148.     mOldTrapAddr = nil;
  149.     
  150.     if (mPatchRoutine) {
  151.         DisposeRoutineDescriptor(mPatchRoutine);
  152.         mPatchRoutine = nil;
  153.     }
  154.  
  155.     // Unlink the patch from the linked list of patches 
  156.     if (this == msPatchList)
  157.         msPatchList = mNextPatch;
  158.     else {
  159.         TrapPatchPtr aPatchPtr = this->GetPreviousPatchPtr();
  160.         if (aPatchPtr != nil)                    // Couldn't find thePatch, don't unpatch it
  161.             aPatchPtr->mNextPatch = mNextPatch;
  162.     }
  163.     mNextPatch = nil;
  164. } 
  165.  
  166.  
  167. //---------------------------------------------------------------
  168. //
  169. // TTrapPatch::UnpatchAll
  170. //
  171. //---------------------------------------------------------------
  172. void TTrapPatch::UnpatchAll()
  173. {
  174.     while (msPatchList != nil)
  175.     {
  176.         msPatchList->UnpatchTrap();
  177.     }
  178. }
  179.  
  180. #pragma mark -
  181.  
  182. // ===================================================================================
  183. //    class TPatchExitToShell
  184. // ===================================================================================
  185.  
  186. enum {
  187.     uppExitToShellProcInfo = kPascalStackBased
  188. };
  189.  
  190. #if    GENERATINGCFM
  191. typedef UniversalProcPtr ExitToShellUPP;
  192.  
  193. #define CallExitToShellProc(userRoutine)    ¥
  194.         CallUniversalProc((UniversalProcPtr)(userRoutine), uppExitToShellProcInfo)
  195. #define NewExitToShellProc(userRoutine)      ¥
  196.         (ExitToShellUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppExitToShellProcInfo, GetCurrentISA())
  197. #else
  198. typedef ProcPtr ExitToShellUPP;
  199.  
  200. #define CallExitToShellProc(userRoutine)    ¥
  201.         (*(userRoutine))()
  202. #define NewExitToShellProc(userRoutine)        ¥
  203.         (ExitToShellUPP)(userRoutine)
  204. #endif
  205.  
  206.  
  207. //---------------------------------------------------------------
  208. //
  209. // TPatchExitToShell::Install
  210. //
  211. //---------------------------------------------------------------
  212. void TPatchExitToShell::Install(ExitToShellType routine)
  213. {
  214.     ASSERT(mPatchRoutine == nil);
  215.  
  216.     mPatchRoutine = NewExitToShellProc(StripAddress(routine));
  217.     ThrowIfMemFail(mPatchRoutine);
  218.     
  219.     this->PatchTrap(_ExitToShell, mPatchRoutine);
  220. }
  221.  
  222.  
  223. //---------------------------------------------------------------
  224. //
  225. // TPatchExitToShell::Remove
  226. //
  227. //---------------------------------------------------------------
  228. void TPatchExitToShell::Remove()
  229. {
  230.     mRemovedTrapAddr = mOldTrapAddr;
  231.  
  232.     this->UnpatchTrap();
  233.  
  234.     ASSERT(mPatchRoutine == nil);
  235. }
  236.  
  237.  
  238. //---------------------------------------------------------------
  239. //
  240. // TPatchExitToShell::CallRemoved
  241. //
  242. //---------------------------------------------------------------
  243. void TPatchExitToShell::CallRemoved()
  244. {
  245.     if (mRemovedTrapAddr == nil)
  246.         mRemovedTrapAddr = mOldTrapAddr;
  247.  
  248.     CallExitToShellProc(mRemovedTrapAddr);
  249. }
  250.  
  251.